Automation

The unique features of FindGraph are exposed through Automation (formerly called OLE Automation). Through the methods and properties that are exposed, client applications written in Microsoft Visual Basic« or Microsoft Visual C++« can be used to control the activities of FindGraph.

Properties:

Document:		see Plot options.
BSTR DocTitle		Plot header
BSTR DocComment		Plot footer
long DocWidth		Plot size on X, 0.1 mm
long DocHeight		Plot size on Y, 0.1 mm
boolean Visible		show/hide FindGraph application main window

Background picture:		See Editor options
boolean DocPictIs		Display or not the background picture
boolean DocPictCentered		To draw the background picture on page center or on left upper corner.
boolean DocPictStretch		Resize or not the background picture on whole size of plot
BSTR DocPictFileName		The background picture file (bmp, gif, jpg, wmf, emf)

Axes:		See Axes options
BSTR AxeXname		The axis X name
BSTR AxeXunit		Physical units of measurement of parameter X
double AxeXstart		The start of X
double AxeXscale		The scale of X in one cm
BSTR AxeYname		The axis Y name
BSTR AxeYunit		Physical units of measurement of parameter Y
double AxeYstart		The start of Y
double AxeYscale		The scale of Y

Series of Points:
long CurrentDotsId		The unique identifier of a series
long ArrayId		Identifier of Variant array used to add at once some points to new series (see example)
VARIANT ArrayVar		Fill this array of dimension 3N with points (X, Y, Z) as VARIANT SAFEARRAY (see example)

Application methods:

void AppInit(short nVisible)
If will use VB you have to call AppInit(1) after CreateObject (see example)

nVisible - Show/Hide FindGraph main window

void AppQuit()
If will use VB you have to call AppQuit() on exit

SCODE OpenDocumentFile(BSTR lpctstr)
Opens an existing FinfGraph document

lpctstr - dovument to be opened, file with extension "fgr"

void DocUpdate()
Updates FindGraph window

Series of points methods

long DotsNew(short nColor, short nShape, short nWidth, double fAspect, BSTR lpctstrName)
Creates new series of points.

nColor - Number of color one of 6 possible:
0    BLACK
1    BLUE
2    GREEN
3    RED
4    BROWN
5    GRAY
nShape - Number of marker
0    Cross
1    Triangle
2    Circle
nWidthDot - Radius of circle point, 0.1 mm;
fAspectDot - Aspect ratio: (Height Y) / (Width X);
lpctstrName - title of a series ;
return the unique identifier of a seriesdwId if success else -1

long DotsFromPict(short nColor, short nWidth, BSTR lpctstrName)
Digitizes background picture and creates new series of points.

parameters - see DotsNew()
return the unique identifier of a seriesdwId if success else -1

SCODE DotsAddPoint(long dwId, double fX, double fY, double fZ)
Adds a point to series

dwId - the unique identifier of a series, returned by DotsNew
fX, fY - values (X, Y) in physical units
return S_FALSE if there is no series with dwId

SCODE DotsAddPoints(long dwId, short nParam, VARIANT varray)
Adds array of points to series

dwId - unique identifier of a series, returned by DotsNew
var - one-dimensional SAFEARRAY:
nParam:
if nParam=2 - fX, fY in physical units in SAFEARRAY:
fX(0), fY(0), fX(1), fY(1), ... fX(n-1), fY(n-1)
if nParam=3 - fX, fY, fZ in physical units in SAFEARRAY:
fX(0), fY(0), fZ(0) ... fX(n-1), fY(n-1), fZ(n-1)
return S_FALSE if there is no series with dwId

SCODE DotsColorNumGet(long dwId, short* pnColorNum)
SCODE DotsColorNumSet(long dwId, short nColorNum)
Get/Set the number of color of series

dwId - the unique identifier of a series, returned by DotsNew
nColorNum - number of color (see DotsNew)
return S_FALSE if there is no series with dwId

SCODE DotsShapeGet(long dwId, short* pnShape)
SCODE DotsShapeSet(long dwId, short nShape)
Get/Set the number of marker of series

dwId - the unique identifier of a series, returned by DotsNew
nShape - number of marker (see DotsNew)
return S_FALSE if there is no series with dwId

SCODE DotsWidthGet(long dwId, short* pnWidth)
SCODE DotsWidthSet(long dwId, short nWidth)
Get/Set the radius of circle point of series

dwId - the unique identifier of a series, returned by DotsNew
nWidth - radius of circle point, 0.1 mm
return S_FALSE if there is no series with dwId

SCODE DotsAspectGet(long dwId, double* pfAspect)
SCODE DotsAspectSet(long dwId, double fAspect)
Get/Set the aspect ratio of series

dwId - the unique identifier of a series, returned by DotsNew
fAspect - aspect ratio Y/X
return S_FALSE if there is no series with dwId

SCODE DotsNameGet(long dwId, BSTR* lptstrName)
SCODE DotsNameSet(long dwId, BSTR lpctstrName)
Get/Set the title of a series

dwId - the unique identifier of a series, returned by DotsNew
lpctstrName - title of a series
return S_FALSE if there is no series with dwId

SCODE DotsShowLine(long dwId, short nShow)
Assigns to connect points with line or no.

dwId - the unique identifier of a series, returned by DotsNew
nShow - if 1 to connect points with line, if 0 not to connect
return S_FALSE if there is no series with dwId

long DotsColor(short nColorNum)
The return value specifies a RGB color calculated on the number of color.

nColorNum - number of color (see DotsNew)
return RGB

SCODE DotsUpdate(long dwId)
This updates the rectangle including all points of series.

dwId - the unique identifier of a series, returned by DotsNew
return S_FALSE if there is no series with dwId

SCODE DotsRemove(long dwId)
Removes series of points

dwId - the unique identifier of a series, returned by DotsNew
return S_FALSE if there is no series with dwId

Selection methods

Get selected dots. With SelectedGetStart we prepare buffer to keep dots. With SelectedGetStopwe free buffer. nParam unused now.

long SelectedGetStart(short nParam)
This prepares the buffer and fills it with points selected.

return the number of points in buffer

long SelectedGetStop(short nParam)
You have to call this to free memory

SCODE SelectedGetDot(double* pfX, double* pfY, double* pfZ)
Function gets point (X,Y,Z) and removes it from buffer (see example).

SCODE SelectedGetDots(short nParam, VARIANT* pvar)
Function gets array of all points (X,Y,Z) selected and removes array from buffer (see example).

pvar - pointer to one-dimensional SAFEARRAY:
nParam:
if nParam=2 - fX, fY in physical units in SAFEARRAY:
fX(0), fY(0), fX(1), fY(1), ... fX(n-1), fY(n-1)
if nParam=3 - fX, fY, fZ in physical units in SAFEARRAY:
fX(0), fY(0), fZ(0) ... fX(n-1), fY(n-1), fZ(n-1)
fX(0), fY(0), fZ(0) ... fX(n-1), fY(n-1), fZ(n-1)

double SelectedGetX(long num)
double SelectedGetY(long num)
double SelectedGetZ(long num)
This returns X (or Y or Z) value of selected point from buffer. First you have to prepare the buffer with SelectedGetStart.

num - number of point in buffer
return X

Areas methods

long ClipNewRect(short nColor, double fXstart, double fYstart, double fXend, double fYend)
Creates new rectangle area, named 'rect'

nColor - number of color
rect: (fXstart, fYstart), (fXend, fYend) - physical coordinates (X, Y) of marks
return current plot dwId if success else -1

SCODE ClipRemove(long dwId)
Removes area

dwId - the unique identifier of a series, returned by ClipNewRect
return S_FALSE if there is no series with dwId

long ClipNewEmptyRgn(short nColor)
Creates new empty area, named 'clip'. You have to add marks with SetArrayVar(var), or ClipNewRgnDot or ClipNewRgn.

nColor - number of color
return current plot dwId if success else -1

SCODE ClipNewRgnDot(long dwId, double fX, double fY)
Adds one mark to area.

dwId - the unique identifier of a series, returned by ClipNewEmptyRect
fX, fY - mark in physical units
return current plot dwId if success else -1

long ClipNewRgn(short nColor, VARIANT var)
Creates new area, named 'clip' with marks from VARIANT array.

nColor - number of color
var - one-dimensional SAFEARRAY of marks
Couples of points (fX, fY) in physical units in SAFEARRAY:
fX(0), fY(0), fX(1), fY(1), ... fX(n-1), fY(n-1)
return current plot dwId if success else -1

SCODE ClipNameSet(long dwId, BSTR lpctstrName)
Sets a title of area

dwId - the unique identifier of a series, returned by ClipNewRect
lpctstrName - title of area
return S_FALSE if there is no series with dwId

SCODE ClipSelect(long dwId, short nSelect)
Selects an area. All points inside of area will be selected.

dwId - the unique identifier of a series, returned by ClipNewRect
nSelect - 1 to select, 0 - to unselect
return S_FALSE if there is no series with dwId

See automation samples, fitting automation methods.